package com.nanhai.buddhist.college.module.collegebase.service.accommodationreside;

import com.nanhai.buddhist.college.framework.common.pojo.PageResult;
import com.nanhai.buddhist.college.module.collegebase.controller.admin.accommodationreside.vo.AccommodationResideCreateReqVO;
import com.nanhai.buddhist.college.module.collegebase.controller.admin.accommodationreside.vo.AccommodationResideExportReqVO;
import com.nanhai.buddhist.college.module.collegebase.controller.admin.accommodationreside.vo.AccommodationResidePageReqVO;
import com.nanhai.buddhist.college.module.collegebase.controller.admin.accommodationreside.vo.AccommodationResideUpdateReqVO;
import com.nanhai.buddhist.college.module.collegebase.dal.dataobject.accommodationreside.AccommodationResideDO;

import javax.validation.Valid;
import java.util.Collection;
import java.util.List;

/**
 * 入住记录 Service 接口
 *
 * @author 南海佛学院
 */
public interface AccommodationResideService {

    /**
     * 创建入住记录
     *
     * @param createReqVO 创建信息
     * @return 编号
     */
    String createAccommodationReside(@Valid AccommodationResideCreateReqVO createReqVO);

    /**
     * 更新入住记录
     *
     * @param updateReqVO 更新信息
     */
    void updateAccommodationReside(@Valid AccommodationResideUpdateReqVO updateReqVO);

    /**
     * 删除入住记录
     *
     * @param id 编号
     */
    void deleteAccommodationReside(String id);

    /**
     * 获得入住记录
     *
     * @param id 编号
     * @return 入住记录
     */
    AccommodationResideDO getAccommodationReside(String id);

    /**
     * 获得入住记录列表
     *
     * @param ids 编号
     * @return 入住记录列表
     */
    List<AccommodationResideDO> getAccommodationResideList(Collection<String> ids);

    /**
     * 获得入住记录分页
     *
     * @param pageReqVO 分页查询
     * @return 入住记录分页
     */
    PageResult<AccommodationResideDO> getAccommodationResidePage(AccommodationResidePageReqVO pageReqVO);

    /**
     * 获得入住记录列表, 用于 Excel 导出
     *
     * @param exportReqVO 查询条件
     * @return 入住记录列表
     */
    List<AccommodationResideDO> getAccommodationResideList(AccommodationResideExportReqVO exportReqVO);

    /**
     * 修改入住状态  -- 迁出
     *
     * @param id
     */
    void updateAccommodationStatusReside(String id);

    /**
     * 迁入
     * @param createReqVO
     * @return
     */
    String addAccommodationReside(AccommodationResideCreateReqVO createReqVO);
}
